.TH squid 8 "Squid Web Proxy 3.1.0.18"
.\" Copyright and licensing information
.\" goes here.
.SH NAME
squid \- proxy caching server
.SH SYNOPSIS
.B squid
[
.B \-dhisrvzCFNRSVYX
] [
.BI \-l " facility"
] [
.BI \-f " config-file"
] [
\-[
.B au
] 
.I port
] [
.B \-k " signal"
] [
.BI \-n " service-name"
] [
.BI \-O " cmd-line"
]
.SH DESCRIPTION
.B squid
is a high-performance proxy caching server for web clients,
supporting FTP, gopher, ICAP, ICP, HTCP and HTTP data objects.
Unlike traditional caching software, 
.B squid
handles all requests in a single, non-blocking process.
.PP
.B squid
keeps meta data and especially hot objects cached in RAM, 
caches DNS lookups, supports non-blocking DNS lookups, and implements
negative caching of failed requests.
.PP
.B squid
supports SSL, extensive access controls, and full request logging. 
By using the lightweight Internet Cache Protocols ICP, HTCP or CARP, 
.B squid 
caches can be arranged in a hierarchy or mesh for additional 
bandwidth savings.
.PP
.B squid
consists of a main server program squid, some optional programs for 
custom processing and authentication, and some management and client
tools.  When squid starts up, it spawns a configurable number of
helper processes, each of which can perform parallel lookups.
This reduces the amount of time the cache waits for results.
.PP
.B squid
is derived from the ARPA-funded Harvest Project 
http://harvest.cs.colorado.edu/
.PP
This manual page only lists the command line arguments.  For details
on how to configure
.B squid
see the file 
.BI @DEFAULT_CONFIG_FILE@.documented,
the Squid wiki FAQ and examples at
http://wiki.squid-cache.org/ ,
or the configuration manual on the
.B squid
home page http://www.squid-cache.org/Doc/config/
.PP

.SH OPTIONS
.IP "-a port"
Specify HTTP port number where Squid should listen for requests, in addition
to any http_port specifications in squid.conf.
.IP "-d level"
Write debugging to stderr also.
.IP "-f file"
Use the given config-file instead of
.IR @DEFAULT_CONFIG_FILE@ .
If the file name starts with a ! or | then it is assumed to be an external
command or command line. Can for example be used to pre-process the
configuration before it is being read by Squid. To facilitate this Squid
also understands the common #line notion to indicate the real source file.
.IP -h
Print help message.
.IP -i
Install as a Windows Service (see -n option).
.IP "-k reconfigure | rotate | shutdown | interrupt | kill | debug | check | parse"
Parse configuration file, then send signal to running copy 
(except -k parse) and exit.
.IP "-n name"
Specify Windows Service name to use for service operations, default is: 
.BI Squid
.
.IP -r
Remove a Windows Service (see -n option).
.IP -s
Enable logging to syslog. Also configurable in
.BI @DEFAULT_CONFIG_FILE@
.IP "-l facility"
Use specified syslog facility. implies -s
.IP "-u port"
Specify ICP port number (default: 3130), disable with 0.
.IP -v
Print version and build details.
.IP -z
Create swap directories
.IP -C
Do not catch fatal signals.
.IP -F
Don't serve any requests until store is rebuilt.
.IP -N
No daemon mode.
.IP "-O options"
Set Windows Service Command line options in Registry.
.IP -R
Do not set REUSEADDR on port.
.IP "-S"
Double-check swap during rebuild.
.IP -X
Force full debugging.
.IP -Y
Only return UDP_HIT or UDP_MISS_NOFETCH during fast reload.

.SH FILES
.I @DEFAULT_CONFIG_FILE@
.RS
The main configuration file.  You must initially make 
changes to this file for 
.B squid
to work.  For example, the default configuration does not 
allow access from any browser.
.RE

.I *.default files
.RS
Reference copy of the configuration file. Always kept up to date with
the version of Squid you are using. Use this to look up the default
configuration settings and syntax after upgrading.
.RE

.I @DEFAULT_CONFIG_FILE@.documented
.RS
Reference copy of the configuration file. Always kept up to date with
the version of Squid you are using. Use this to read the documentation
for configuration options available in your build of Squid. The online
configuration manual is also available for a full reference of options.
.BR see http://www.squid-cache.org/Doc/config/
.RE

.I cachemgr.conf
.RS
The main configuration file for the web cachemgr.cgi tools.
.RE

.I msntauth.conf
.RS
The main configuration file for the Sample MSNT authenticator.
.RE

.I errorpage.css
.RS
CSS Stylesheet to control the display of generated error pages.
Use this to set any company branding you need, it will apply to every
Language Squid provides error pages for.
.RE

.I @DEFAULT_MIME_TABLE@ (mime_table)
.RS
MIME type mappings for FTP gatewaying
.RE

.I @DEFAULT_ERROR_DIR@
.RS
Location of
.B squid 
error pages and templates.
.RE

.SH SEE ALSO
.BR cachemgr.cgi "(8), "
.BR pam_auth "(8), "
.BR squid_ldap_auth "(8), "
.BR squid_ldap_group "(8), "
.BR squid_session "(8), "
.BR squid_unix_group "(8), "
.br
.B The Squid FAQ wiki http://wiki.squid-cache.org/SquidFaq
.B The Squid Configuration Manual http://www.squid-cache.org/Doc/config/



.\" Could add the following sections:
.\" .SH ENVIRONMENT
.\" .SH DIAGNOSTICS
.\" .SH BUGS
.\" .SH AUTHOR
.\" .SH SEE ALSO

